Scene

[POST] /api/v2/dashboard/scenes

请求数据格式

SceneBaseViewModel

返回值

状态码: 201

已创建

SceneResponse

状态码: 400

错误的请求

ServerPluginError

状态码: 403

禁止

ServerPluginError

状态码: 404

未找到

ServerPluginError

[GET] /api/v2/dashboard/scenes/{id}

获取场景

参数:

名称	类型	位置	描述
id必填项	string	path	场景ID
rev	int32	query	场景修改

返回值

状态码: 200

成功

SceneViewModel

状态码: 400

错误的请求

ServerPluginError

状态码: 403

禁止

ServerPluginError

状态码: 404

未找到

ServerPluginError

[PUT] /api/v2/dashboard/scenes/{id}

更新场景

参数:

名称	类型	位置	描述
id必填项	string	path	场景ID

请求数据格式

SceneBaseViewModel

返回值

状态码: 200

成功

状态码: 400

错误的请求

ServerPluginError

状态码: 403

禁止

ServerPluginError

状态码: 404

未找到

ServerPluginError

[DELETE] /api/v2/dashboard/scenes/{id}

删除场景

参数:

名称	类型	位置	描述
id必填项	string	path	场景ID

返回值

状态码: 200

成功

状态码: 400

错误的请求

ServerPluginError

状态码: 403

禁止

ServerPluginError

状态码: 404

未找到

ServerPluginError

[POST] /api/v2/dashboard/scenes/{id}/revert

恢复场景

参数:

名称	类型	位置	描述
id必填项	string	path	场景ID
rev	int32	query	场景修改

返回值

状态码: 400

错误的请求

ServerPluginError

状态码: 403

禁止

ServerPluginError

状态码: 404

未找到

ServerPluginError

[GET] /api/v2/dashboard/scenes/{id}/download

参数:

名称	类型	位置
id必填项	string	path

返回值

状态码: 200

成功

类型定义

Ƭ SceneResponse

场景 POST 响应

名称	类型	描述	示例
sceneId可为空	string	新场景ID

Ƭ ServerPluginError

服务器插件错误

名称	类型	描述	示例
code可为空	string	错误代码
message可为空	string	错误信息
context可为空	string	错误上下文

Ƭ SceneBaseViewModel

名称	类型	描述	示例
title可为空	string
comment可为空	string
tagIds可为空	Array<string>
datasetProfiles可为空	any
sharedResources可为空	SharedResource
options可为空	any
models可为空	Array
meshes可为空	Array
lights可为空	Array
cameras可为空	Array
dataLayers可为空	Array
content	Content
parameters可为空	DashboardParameter
version可为空	string

Ƭ SharedResource

名称	类型	描述	示例
id可为空	string
type	DocumentType

Ƭ Content

名称	类型	描述	示例
docTheme可为空	any
filters可为空	Array
imageList可为空	DashboardImage
languageResource可为空	any

Ƭ DashboardParameter

名称	类型	描述	示例
name可为空	string	参数名称。
prompt可为空	string	提示输入参数值时向用户显示的文本。
dataType可为空	string	参数的数据类型。
outputDataType可为空	string
dateOnly	Boolean
multiValue	Boolean
multiline	Boolean
hidden	Boolean
allowBlank	Boolean
validValues	ValidValues
defaultValue	DefaultValue
binding	Binding
transform	Transform
valueType可为空	string

Ƭ DocumentType

Enum:

• Unknown
• Dashboard
• Dataset
• DataSource
• Image
• Theme
• MapHierarchy
• GeoJson
• Report
• Visual
• FloorPlan
• AnalysisModel
• Font
• LanguageResource
• NativeQuery
• Scene
• Glb
• DashboardTemplate
• VizTemplate

Ƭ DashboardImage

名称	类型	描述	示例
id可为空	string
name可为空	string
src可为空	string
size	int32
type可为空	string
dashboardId可为空	string

Ƭ ValidValues

名称	类型	描述	示例
datasetReference	DatasetReference
values可为空	ParameterValue	获取参数的可能值的列表。

Ƭ DefaultValue

名称	类型	描述	示例
datasetReference	DatasetReference
values可为空	Array<string>	获取参数的默认值。
logicValues可为空	LogicValue	获取默认值的逻辑值。

Ƭ Binding

名称	类型	描述	示例
value	ParameterBindingValue
valueType可为空	string

Ƭ Transform

名称	类型	描述	示例
rule可为空	string
direction可为空	string
unit可为空	string
formatter可为空	string

Ƭ DatasetReference

表示要执行的查询以获得参数的默认值。

名称	类型	描述	示例
datasetId可为空	string
valueField可为空	string
entityName可为空	string
aggType可为空	string

Ƭ ParameterValue

名称	类型	描述	示例
label可为空	string	要在 UI 中显示的值的标签
value可为空	string	指定参数的值。

Ƭ LogicValue

名称	类型	描述	示例
valueType可为空	string
value可为空	string
datasetReference	DatasetReference

Ƭ ParameterBindingValue

名称	类型	描述	示例
name可为空	string
valuePropertyName可为空	string
columns可为空	Array<string>
checkedFieldNames可为空	Array<string>

Ƭ SceneViewModel

名称	类型	描述	示例
id可为空	string
title可为空	string
comment可为空	string
tagIds可为空	Array<string>
datasetProfiles可为空	any
sharedResources可为空	SharedResource
options可为空	any
models可为空	Array
meshes可为空	Array
lights可为空	Array
cameras可为空	Array
dataLayers可为空	Array
content	Content
parameters可为空	DashboardParameter
version可为空	string